home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsISafeOutputStream.idl < prev    next >
Text File  |  2006-05-08  |  3KB  |  73 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Michiel van Leeuwen (mvl@exedo.nl).
  19.  * Portions created by the Initial Developer are Copyright (C) 2004
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Daniel Witte (dwitte@stanford.edu)
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. #include "nsISupports.idl"
  40.  
  41. /**
  42.  * This interface provides a mechanism to control an output stream
  43.  * that takes care not to overwrite an existing target until it is known
  44.  * that all writes to the destination succeeded.
  45.  * 
  46.  * An object that supports this interface is intended to also support
  47.  * nsIOutputStream.
  48.  *
  49.  * For example, a file output stream that supports this interface writes to
  50.  * a temporary file, and moves it over the original file when |finish| is
  51.  * called only if the stream can be successfully closed and all writes
  52.  * succeeded.  If |finish| is called but something went wrong during
  53.  * writing, it will delete the temporary file and not touch the original.
  54.  * If the stream is closed by calling |close| directly, or the stream
  55.  * goes away, the original file will not be overwritten, and the temporary
  56.  * file will be deleted.
  57.  *
  58.  * Currently, this interface is implemented only for file output streams.
  59.  */
  60. [scriptable, uuid(5f914307-5c34-4e1f-8e32-ec749d25b27a)]
  61. interface nsISafeOutputStream : nsISupports
  62. {
  63.     /**
  64.      * Call this method to close the stream and cause the original target
  65.      * to be overwritten. Note: if any call to |write| failed to write out
  66.      * all of the data given to it, then calling this method will |close| the
  67.      * stream and return failure. Further, if closing the stream fails, this
  68.      * method will return failure. The original target will be overwritten only
  69.      * if all calls to |write| succeeded and the stream was successfully closed.
  70.      */
  71.     void finish();
  72. };
  73.